Simplify text shown for (stable, removed) feature gates #52632
Conversation
Handle removed features differently. When a feature has graduated to stable and has since been removed, don't show the info box that we use for feature gates that Kubernetes still recognizes. Instead, show a simple paragraph explaining the situation.
k8s-ci-robot
added
area/web-development
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
sig/docs
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Example of a feature gate not marked as removed, legacy means to specify it: No explanatory text but still works. Example of a feature gate not marked as removed, recommended means to specify it, recent graduation:
Example of a feature gate marked as removed, recommended means to specify it:
I have deliberately picked an example that is a little stale. Even if we make this this change, we should revise https://kubernetes.io/docs/concepts/architecture/nodes/#node-topology to remove ”If you have enabled the TopologyManager feature gate, then…”. I would also remove the feature gate shortcode from that section at the same time, as it's been stable for a while. However, this PR is not the place to fix that. We could use #52626 for that work, or tweak #52626 to leave in some feature gates where the removal is relatively recent. Bear in mind that if we add metadata to record whether feature gates are locked, we can tweak the logic without needing to change the message. The statements in the docs would remain true. |
|
Want different text? Feel free to suggest changes to it. |
| [feature_gate_stable_graduated] | ||
| other = "This is a stable feature in Kubernetes, and has been since version {{ .stableVersion }}. It was first available in the v{{ .firstReleaseWithThisFeature }} release." | ||
|
|
||
| [feature_gate_stable_locked] | ||
| other = "This is a stable feature in Kubernetes, and has been since version {{ .stableVersion }}. It was first available in the v{{ .firstReleaseWithThisFeature }} release. You can no longer disable or opt of of this behavior." | ||
|
|
There was a problem hiding this comment.
This text / template is easy to amend.
|
There are some slight differences between the following states of a feature gate:
For gates that have been removed, we may want to drop the anchors instead of carry them on forever. |
I agree. And I hope that a future PR continues our improvement journey.
Anchors? If you mean shortcodes, then removing the shortcodes can still happen. I propose retaining the shortcode for a number of releases after it has been removed, or since it became stable. |
Handle removed features differently. When a feature has graduated to stable and has since been removed, don't show the info box that we use for feature gates that Kubernetes still recognizes. Instead, show a simple paragraph explaining the situation.
/area web-development
The idea I have is to use the metadata we already have (
removed) to decide what text to show to readers.For previews, see #52632 (comment)